Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add PSRT coordination process and messaging templates #1348

Merged
merged 9 commits into from
Jul 16, 2024

Conversation

sethmlarson
Copy link
Contributor

@sethmlarson sethmlarson commented Jul 11, 2024

This documents the process for PSRT coordination which matches the proposal sent to the Python Security Response Team. Note that GitHub Security Advisories are not yet active for the CPython repository, but this process works mostly the same just without a canonical place to record the information and collaborate.

cc @zooba @gpshead @ned-deily @warsaw


📚 Documentation preview 📚: https://cpython-devguide--1348.org.readthedocs.build/

Copy link
Member

@zooba zooba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting approach to line wrapping 😆 But otherwise it looks great.

Looking forward to seeing how the GitHub Advisories stuff works. I've never been on this side of it before.

developer-workflow/psrt.rst Outdated Show resolved Hide resolved

Please see the linked CVE ID for the latest information on affected versions:

* https://www.cve.org/CVERecord?id={CVE-YYYY-XXXX}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This link won't work on initial disclosure, right? Or do they activate that quickly?

Agreed with keeping it in the initial email though, since these get publicly archived and essentially are our disclosure mechanism.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It becomes public almost instantly after it's pushed, but yes it requires a manual publication from the PSF CNA.

developer-workflow/psrt.rst Outdated Show resolved Hide resolved

* Affected versions. This could be "all versions", but if the vulnerability exists in a new feature
or removed feature then this could be different. Include versions that are end-of-life in this calculation.
(e.g. "Python 3.9 and earlier", "Python 3.10 and later", "all versions of Python")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we be more precise with these? Generally it's going to be "all the latest versions as of the day we disclose", which means we can easily figure out the real list.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might also be useful to describe which versions are (or will be) EOL as of the disclosure date.

developer-workflow/psrt.rst Show resolved Hide resolved
developer-workflow/psrt.rst Outdated Show resolved Hide resolved
Very minor formatting and spelling fixes.  `code-block` is I think incorrect in that the examples are plain text, so just use `::` to delineate.
Copy link
Member

@warsaw warsaw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I couldn't figure out how to suggest a change so I just went ahead and committed a few minor typo and formatting changes. Other than that, and the comments by the others, LGTM!

developer-workflow/psrt.rst Outdated Show resolved Hide resolved
developer-workflow/psrt.rst Outdated Show resolved Hide resolved
developer-workflow/psrt.rst Outdated Show resolved Hide resolved
developer-workflow/psrt.rst Outdated Show resolved Hide resolved
developer-workflow/psrt.rst Show resolved Hide resolved
developer-workflow/psrt.rst Outdated Show resolved Hide resolved
developer-workflow/psrt.rst Outdated Show resolved Hide resolved
Co-authored-by: Ezio Melotti <[email protected]>
Co-authored-by: Steve Dower <[email protected]>
Copy link
Member

@ezio-melotti ezio-melotti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some additional nitpicking: wavy subsections are frowned upon.

developer-workflow/psrt.rst Outdated Show resolved Hide resolved
developer-workflow/psrt.rst Outdated Show resolved Hide resolved
developer-workflow/psrt.rst Outdated Show resolved Hide resolved
* Remove more contractions.
* Fix the header format ('~' -> '-')
* Indicate more clearly which steps of the process
  are done by the coordinator.
* Limit the line lengths of template responses to 80 chars
Copy link
Member

@ned-deily ned-deily left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The rendered Rejecting a vulnerability report template is still incorrectly formatted. I believe a .. highlight:: none will fix it.

@sethmlarson sethmlarson requested a review from ned-deily July 12, 2024 19:56
Copy link
Member

@ned-deily ned-deily left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

developer-workflow/psrt.rst Outdated Show resolved Hide resolved
developer-workflow/psrt.rst Outdated Show resolved Hide resolved
developer-workflow/psrt.rst Outdated Show resolved Hide resolved
developer-workflow/psrt.rst Outdated Show resolved Hide resolved
developer-workflow/psrt.rst Outdated Show resolved Hide resolved
developer-workflow/psrt.rst Outdated Show resolved Hide resolved
developer-workflow/psrt.rst Outdated Show resolved Hide resolved
developer-workflow/psrt.rst Outdated Show resolved Hide resolved
@hugovk hugovk changed the title Add coordination process and messaging templates to Developer Guide Add coordination process and messaging templates Jul 13, 2024
sethmlarson and others added 2 commits July 15, 2024 11:02
@sethmlarson
Copy link
Contributor Author

Thanks @hugovk and @ezio-melotti for putting together the review comments with fixes! 🙏

@zooba
Copy link
Member

zooba commented Jul 15, 2024

I don't have any further thoughts or suggestions at this point, but I'm assuming we'll refine things as we go. (If the intent is to lock us into this process precisely, then I'll take the time to be more thorough and imaginative before approving.)

@sethmlarson
Copy link
Contributor Author

@zooba We can continue to refine the process as we learn more and encounter edge-cases, this gives us a better place for those improvements to land instead of becoming "institutional knowledge" :)

@AA-Turner AA-Turner changed the title Add coordination process and messaging templates Add PSRT coordination process and messaging templates Jul 16, 2024
@sethmlarson
Copy link
Contributor Author

I think all reviewers have left their comments or approved including all PSRT admins. Thanks everyone for the reviews! Happy whenever we're ready to merge this one.

@hugovk hugovk merged commit 890564f into python:main Jul 16, 2024
4 checks passed
@sethmlarson sethmlarson deleted the psrt branch July 16, 2024 21:04
@sethmlarson
Copy link
Contributor Author

Thanks @hugovk! 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants